Skip to main content
Version: 1.0.2

Get Transactions

The Get Transactions API enables to fetch and show the list of transactions.

Method: POST​

{{URL}}/jsonrpc

Headers​

NameValue
Content-Typeapplication/json

Example​

Payload Parameters
ParameterDescription

id

Mandatory

String

Unique ID of request

Example – "1"

method

Mandatory

String

Method Name

Example – "VisaService.GetTransactions"

params

Mandatory

Object

api

Mandatory

Object

credential

Mandatory

String

API credential provided by NetXD

Example – "Basic cy5wYXJhbWVzd2FyYW4rMkBiYW5rY2J3Lm9yZzpUZXN0QDEyMzQ="

signature

Mandatory

String

Signature of the digitally signed payload

Example – "MEQCICSDF4HIunb4xDLVEK9IOJYhT6j4wq5FwfJILSb4xbeSAiBdmpkV7uPB+39O6S+ea/61ar3dBmBNSU9ay229vin7sA=="

payload

Mandatory

Object

pageNo

Optional

Number

Current page number

Example – 1

pageSize

Optional

Number

Number of records per page that can contain

Example – 10

paymentId

Optional

String

Unique identifier of the payment helps to track transaction

Example – "84214423"

Status

Optional

String

Current status of the transaction

Example – "PENDING"

endToEndIdentification

Optional

String

ID that helps to trace the transaction

Example – "R1708598119292"

companyId

Optional

String

ID of the company associated with the transaction

Example – "658bcbe121dc6c32ec0120a2"

paymentMode

Optional

String

Mode of transaction

Example – "SWIFT"

transactionCredit

Optional

String

Whether the type of transaction is inbound or outbound

Example – "OUT"

fromDate

Optional

String

Date and time of the transaction was initiated

Example – "2024-02-18"

toDate

Optional

String

Date and time of the transaction was completed

Example – "2024-03-01"


curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"id":"1","method":"VisaService.GetTransactions","params":{"api":{"credential":"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5","signature":"MEQCICSDF4HIunb4xDLVEK9IOJYhT6j4wq5FwfJILSb4xbeSAiBdmpkV7uPB+39O6S+ea/61ar3dBmBNSU9ay229vin7sA=="},"payload":{"pageNo":1,"pageSize":10,"paymentId":"84214423","status":"PENDING","endToEndIdentification":"R1708598119292","companyId":"658bcbe121dc6c32ec0120a2","paymentMode":"SWIFT","transactionCredit":"OUT","fromDate":"2024-02-18","toDate":"2024-03-01"}}}'

Body​


{
  "id": "1",
  "method": "VisaService.GetTransactions",
  "params": {
    "api": {
      "credential": "Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5",
      "signature": "MEQCICSDF4HIunb4xDLVEK9IOJYhT6j4wq5FwfJILSb4xbeSAiBdmpkV7uPB+39O6S+ea/61ar3dBmBNSU9ay229vin7sA=="
    },
    "payload": {
      "pageNo": 1,
      "pageSize": 10,
      "paymentId": "84214423",
      "status": "PENDING",
      "endToEndIdentification": "R1708598119292",
      "companyId": "658bcbe121dc6c32ec0120a2",
      "paymentMode": "SWIFT",
      "transactionCredit": "OUT",
      "fromDate": "2024-02-18",
      "toDate": "2024-03-01"
    }
  }
}

Response: 201​

Response Parameters
ParameterDescription

jsonrpc

String

JSON RPC VERSION

Example – "2.0"

result

Object

totalElements

Number

Total number of elements or transactions

Example – 1

transactions

Array

id

String

Unique ID of transaction

Example – "65df3b29bc2422fb17c9754a"

postingDate

String

Transaction initiated date and time

Example – "2024-02-28T13:54:49.606Z"

status

String

Status of transaction

Example – "PENDING"

referenceNumber

String

Reference number of transaction

Example – "3534tt12222r44b4x9nrtr1681"

debtorAgentBid

Number

Bank ID of debtor bank or financial institution

Example – "12345678"

debtorAgentBic

String

Bank Identifier Code of debtor bank or financial institution

Example – "PNCBAT40"

debtorEnterpriseId

String

Unique identifier of the debtor's enterprise

Example – "V-USA-EUR-10080373-100000001-001"

debtorAccountNumber

String

Account number of debtor

Example – "123132"

debtorName

String

Name of the debtor

Example – "ABC"

creditorEnterpriseId

String

Unique identifier of the creditor's enterprise

Example – "V-GBR-USD-081302633-USABA-100914939-001"

creditorAccountNumber

String

Account number of creditor

Example – "2342342"

instructedCurrency

String

Currency of transaction

Example – "USD"

instructedAmount

Number

Amount of transaction

Example – 1.1

visaresponse

Object

paymentId

String

Unique ID of the payment helps to track transaction

Example – "45268341"

structuredRemittance

Null

Structured remittance information related to payment

Example – null

customerOrgName

String

Customer organisation name that initiated transaction

Example – "ABC"

bankName

String

Name of the beneficiary bank

Example – "XYZ"

riskScore

String

Level of risk associated with the transaction

Example – "Disabled"

paymentMode

String

Mode of transaction

Example – "API"

nameScreening

Object

watchListStatus

String

Status of watchlist

Example – "Disabled"

validatePayment

Object

validateStatus

String

Status of transaction validation

Example – "FAILED"

id

String

Unique ID of request

Example – "1"


{
  "jsonrpc": "2.0",
  "result": {
    "totalElements": 1,
    "transactions": [
      {
        "id": "65df3b29bc2422fb17c9754a",
        "postingDate": "2024-02-28T13:54:49.606Z",
        "status": "PENDING",
        "referenceNumber": "3534tt12222r44b4x9nrtr1681",
        "debtorAgentBid": 12345678,
        "debtorAgentBic": "PNCBAT40",
        "debtorEnterpriseId": "V-USA-EUR-10080373-100000001-001",
        "debtorAccountNumber": "123132",
        "debtorName": "ABC",
        "creditorEnterpriseId": "V-GBR-USD-081302633-USABA-100914939-001",
        "creditorAccountNumber": "2342342",
        "instructedCurrency": "USD",
        "instructedAmount": 1.1,
        "visaresponse": {
          "paymentId": "45268341"
        },
        "structuredRemittance": null,
        "customerOrgName": "ABC",
        "bankName": "XYZ",
        "riskScore": "Disabled",
        "paymentMode": "API",
        "nameScreening": {
          "watchListStatus": "Disabled"
        },
        "validatePayment": {
          "validateStatus": "FAILED"
        }
      }
    ]
  },
  "id": "1"
}